openapi: 3.1.0
info:
  title: Local API
  description: >-
    The MoreLogin API offers a comprehensive and developer-friendly RESTful
    interface that empowers you to programmatically manage browser profiles,
    cloud phones, and related resources—enabling seamless automation,
    scalability, and control.The MoreLogin local API runs on your machine and is
    accessible at:127.0.0.1:40000
  version: 1.0.0
tags:
  - name: Browser Profile
  - name: Cloud Phone
  - name: Cloud Phone/File Management
  - name: Cloud Phone/App Management
  - name: Cloud Phone/Schedules management
  - name: Proxy Management
  - name: Group Management
  - name: Tag Management
paths:
  /api/env/start:
    post:
      summary: Start browser profile
      operationId: startBrowserProfileUsingPOST
      deprecated: false
      description: |
        Used to start the profile; you must specify the profile ID. After
        successful startup, you can obtain the profile debug interface for
        executing Selenium and Puppeteer automation. For Selenium, use the
        WebDriver matching the corresponding kernel version. The WebDriver path
        can be retrieved from the response after profile startup. Requires
        MoreLogin client version 2.15.0 or higher.
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                envId:
                  type: string
                  description: >
                    Environment ID. At least one of `envId` or `uniqueId` must
                    be provided.

                    If both are given, `envId` takes precedence.
                  example: '1993244721490239488'
                uniqueId:
                  type: integer
                  description: >
                    Environment serial number (small integer ID). At least one
                    of `envId` or `uniqueId` must be provided.

                    If both are given, `envId` takes precedence.
                  example: 1
                encryptKey:
                  type: string
                  description: >
                    Encryption key. Required only if end-to-end encryption is
                    enabled for the environment.
                  example: xxx
                isHeadless:
                  type: boolean
                  description: >
                    Whether to start in headless mode. Defaults to `false` if
                    omitted.

                    Note: Requires client version v2.36.0 or higher.
                  Default: false
                  example: false
                cdpEvasion:
                  type: boolean
                  description: |
                    Enable CDP fingerprint evasion to reduce detection risk.
                    Only applies to PC environments.
                    Default:`false`.
                    Note: Requires client version v2.36.0 or higher.
                  Default: false
                  example: false
            example:
              envId: '1993244721490239488'
              encryptKey: xxx
              isHeadless: false
              uniqueId: 1
              cdpEvasion: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      envId:
                        type: string
                        description: profile
                      debugPort:
                        type: string
                      type:
                        type: string
                      version:
                        type: integer
                      webdriver:
                        type: string
                    required:
                      - envId
                      - debugPort
                      - type
                      - version
                      - webdriver
                required:
                  - data
          headers: {}
      security: []
  /api/env/close:
    post:
      summary: Stop browser profile
      deprecated: false
      description: >-
        Closes the specified environment. Requires specifying the environment
        ID. Requires MoreLogin application v2.15.0 or higher.
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                envId:
                  description: >-
                    Environment ID or serial number — at least one must be
                    provided; if both, envId takes precedence.
                  type: string
                uniqueId:
                  description: >-
                    Environment serial number — at least one of 'envId' or
                    'uniqueId' must be provided; if both, 'envId' takes
                    precedence.
                  type: integer
            example:
              envId: '1869649942658850816'
              uniqueId: 0
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      envId:
                        type: string
                      debugPort:
                        type: string
                    required:
                      - envId
                      - debugPort
                required:
                  - code
                  - msg
                  - data
          headers: {}
      security: []
  /api/env/create/quick:
    post:
      summary: Quick create browser profile
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                browserTypeId:
                  description: 1:Chrome, 2:Firefox
                  type: integer
                  example: 1
                groupId:
                  description: Environment group ID; default:ungrouped (0)
                  type: integer
                  example: 0
                isEncrypt:
                  description: Enable end-to-end encryption? 0:No, 1:Yes; default:0
                  type: integer
                operatorSystemId:
                  description: OS type 1:Windows, 2:macOS, 3:Android, 4:iOS
                  type: integer
                  example: 1
                quantity:
                  description: Number of environments to create; range:[1–50]
                  type: integer
                  minimum: 1
                  maximum: 50
                  example: 1
                browserCore:
                  description: >-
                    Browser kernel version; default:0 (auto-match). Obtain
                    available versions via '/api/env/advanced/ua/versions'
                  type: integer
                  example: 140
              required:
                - browserTypeId
                - operatorSystemId
                - quantity
            example:
              browserTypeId: 1,
              operatorSystemId: 1,
              quantity: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: array
                    items:
                      type: string
                  requestId:
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
          headers: {}
      security: []
  /api/env/create/advanced:
    post:
      summary: Advanced create browser profile
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                browserTypeId:
                  type: integer
                operatorSystemId:
                  type: integer
                envName:
                  type: string
                browserCore:
                  type: integer
                cookies:
                  type: string
                envRemark:
                  type: string
                groupId:
                  type: integer
                isEncrypt:
                  type: integer
                proxyId:
                  type: integer
                tagIds:
                  type: array
                  items:
                    type: integer
                uaVersion:
                  type: integer
                startupParams:
                  type: array
                  items:
                    type: string
                disableAudio:
                  type: integer
                disableVideo:
                  type: integer
                disableImg:
                  type: integer
                imgLimitSize:
                  type: integer
                accountInfo:
                  type: object
                  properties:
                    platformId:
                      type: integer
                    customerUrl:
                      type: string
                    username:
                      type: string
                    password:
                      type: string
                    otpSecret:
                      type: string
                    siteId:
                      type: integer
                  required:
                    - platformId
                    - customerUrl
                    - username
                    - password
                    - otpSecret
                    - siteId
                advancedSetting:
                  type: object
                  properties:
                    ua:
                      type: string
                    time_zone:
                      type: object
                      properties:
                        switcher:
                          type: integer
                        value:
                          type: string
                      required:
                        - switcher
                        - value
                    web_rtc:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    geo_location:
                      type: object
                      properties:
                        switcher:
                          type: integer
                        base_on_ip:
                          type: boolean
                        latitude:
                          type: integer
                        longitude:
                          type: integer
                        accuracy:
                          type: integer
                      required:
                        - switcher
                        - base_on_ip
                        - latitude
                        - longitude
                        - accuracy
                    language:
                      type: object
                      properties:
                        switcher:
                          type: integer
                        value:
                          type: string
                      required:
                        - switcher
                        - value
                    resolution:
                      type: object
                      properties:
                        switcher:
                          type: integer
                        id:
                          type: string
                      required:
                        - switcher
                        - id
                    font:
                      type: object
                      properties:
                        switcher:
                          type: integer
                        value:
                          type: string
                      required:
                        - switcher
                        - value
                    canvas:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    webgl_image:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    webgl_metadata:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    audio_context:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    media_device:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    client_rects:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    speech_voise:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    hardware_concurrency:
                      type: integer
                    memery_device:
                      type: integer
                    do_not_track:
                      type: integer
                    bluetooth:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    battery:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    port_scan_protectio:
                      type: object
                      properties:
                        switcher:
                          type: integer
                        value:
                          type: string
                      required:
                        - switcher
                        - value
                    os_version:
                      type: string
                    web_gpu:
                      type: object
                      properties:
                        switcher:
                          type: integer
                      required:
                        - switcher
                    ciphers:
                      type: object
                      properties:
                        switcher:
                          type: integer
                        value:
                          type: string
                      required:
                        - switcher
                        - value
                    mobile_device:
                      type: integer
                  required:
                    - ua
                    - time_zone
                    - web_rtc
                    - geo_location
                    - language
                    - resolution
                    - font
                    - canvas
                    - webgl_image
                    - webgl_metadata
                    - audio_context
                    - media_device
                    - client_rects
                    - speech_voise
                    - hardware_concurrency
                    - memery_device
                    - do_not_track
                    - bluetooth
                    - battery
                    - port_scan_protectio
                    - os_version
                    - web_gpu
                    - ciphers
                    - mobile_device
                afterStartupConfig:
                  type: object
                  properties:
                    afterStartup:
                      type: integer
                    autoOpenUrls:
                      type: string
                  required:
                    - afterStartup
                    - autoOpenUrls
              required:
                - browserTypeId
                - operatorSystemId
            example:
              accountInfo:
                platformId: 9999
                customerUrl: ''
                username: ''
                password: ''
                otpSecret: ''
                siteId: 0
              advancedSetting:
                ua_version: 140
                os: 2
                time_zone:
                  switcher: 2
                  value: '1703673608443793408'
                web_rtc:
                  switcher: 4
                geo_location:
                  switcher: 2
                  base_on_ip: true
                  longitude: 0
                  latitude: 0
                  accuracy: 17000
                resolution:
                  switcher: 2
                  id: '1703673947297419264'
                font:
                  switcher: 1
                  value: ''
                canvas:
                  switcher: 2
                webgl_image:
                  switcher: 1
                webgl_metadata:
                  switcher: 1
                web_gpu:
                  switcher: 3
                speech_voise:
                  switcher: 1
                audio_context:
                  switcher: 1
                media_device:
                  switcher: 2
                client_rects:
                  switcher: 2
                hardware_concurrency: 6
                memery_device: 4
                port_scan_protection:
                  switcher: 1
                  value: ''
                battery:
                  switcher: 2
                bluetooth:
                  switcher: 1
                do_not_track: 2
                language:
                  switcher: 1
                  value: 1703673595865075712,1703673597404385280
                ua: >-
                  Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
                  AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.6422.61
                  Safari/537.36
              cookies: ''
              afterStartupConfig:
                afterStartup: 3
                autoOpenUrls:
                  - https://www.x.com
                platformUrl: https://www.facebook.com/
              browserCore: 0
              browserTypeId: 1
              envName: ''
              envRemark: ''
              groupId: 0
              isEncrypt: 0
              operatorSystemId: 2
              proxyId: 0
              tagIds: []
              uaVersion: 0
              disableAudio: 0
              disableVideo: 0
              disableImg: 0
              imgLimitSize: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: string
                  requestId:
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
          headers: {}
      security: []
  /api/env/update:
    post:
      summary: Modify browser profile
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      schema:
        $ref: '#/components/schemas/EnvironmentRequest'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example:
              accountInfo:
                customerUrl: ''
                password: ''
                platformId: 1
                siteId: 207
                username: ''
              advancedSetting: {}
              afterStartupConfig:
                afterStartup: 1
                autoOpenUrls: []
              browserCore: 0
              cookies: ''
              envName: ''
              envRemark: Test11
              groupId: 0
              envId: '1874031091276914688'
              proxyId: 0
              tagIds: []
              uaVersion: 0
              disableAudio: 0
              disableImg: 0
              disableVideo: 0
              imgLimitSize: 1000
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: 'null'
                  requestId:
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
          headers: {}
      security: []
  /api/env/removeToRecycleBin/batch:
    post:
      summary: Delete browser profile
      operationId: batchDeleteBrowserProfilesUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - envIds
              properties:
                envIds:
                  type: array
                  description: List of environment (browser profile) IDs to delete.
                  items:
                    type: string
                    example: '1868548141708648448'
                  minItems: 1
                  example:
                    - '1868548141708648448'
                    - '1868548141708648449'
                removeEnvData:
                  type: boolean
                  description: |
                    Also delete local configuration files?
                    Supported in v2.28.0+.
                  Default: false
                  example: false
            example:
              envIds:
                - '1868548141708648448'
              removeEnvData: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: boolean
                  requestId:
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
          headers: {}
      security: []
  /api/env/page:
    post:
      summary: Get a list of browser profiles
      operationId: listBrowserProfilesUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                envName:
                  type: string
                  description: >-
                    Filter by environment (profile) name. Empty string returns
                    all.
                  example: ''
                groupId:
                  type: integer
                  description: Filter by group ID. Use 0 for ungrouped profiles.
                  Default: 0
                  example: 0
                envId:
                  type: string
                  description: |
                    Filter by specific environment ID.
                    If provided, other filters may be ignored.
                  example: '1869988538611834880'
                pageNo:
                  type: integer
                  description: Page number (1-based index).
                  Default: 1
                  minimum: 1
                  example: 1
                pageSize:
                  type: integer
                  description: Number of items per page.
                  Default: 10
                  minimum: 1
                  maximum: 100
                  example: 10
            example:
              envName: ''
              groupId: 0
              envId: '1869988538611834880'
              pageNo: 1
              pageSize: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      total:
                        type: string
                      current:
                        type: string
                      pages:
                        type: string
                      dataList:
                        type: array
                        items:
                          type: string
                    required:
                      - total
                      - current
                      - pages
                      - dataList
                  requestId:
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
          headers: {}
      security: []
  /api/env/detail:
    post:
      summary: Get browser profile details
      operationId: getBrowserProfileDetailsUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - envId
              properties:
                envId:
                  type: string
                  description: Target environment (browser profile) ID
                  example: '1869988538611834880'
            example:
              envId: '1869988538611834880'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      envName:
                        type: string
                      browserTypeId:
                        type: integer
                      operatorSystemId:
                        type: integer
                      groupId:
                        type: string
                      tagIds:
                        type: 'null'
                      proxyId:
                        type: string
                      isEncrypt:
                        type: integer
                      envRemark:
                        type: string
                      uaVersion:
                        type: integer
                      browserCore:
                        type: integer
                      accountInfo:
                        type: object
                        properties:
                          username:
                            type: string
                          password:
                            type: string
                          siteId:
                            type: string
                          platformId:
                            type: string
                          customerUrl:
                            type: string
                          otpSecret:
                            type: 'null'
                        required:
                          - username
                          - password
                          - siteId
                          - platformId
                          - customerUrl
                          - otpSecret
                      isShowAccount:
                        type: integer
                      afterStartupConfig:
                        type: object
                        properties:
                          afterStartup:
                            type: integer
                          autoOpenUrls:
                            type: array
                            items: {}
                          platformUrl:
                            type: 'null'
                        required:
                          - afterStartup
                          - autoOpenUrls
                          - platformUrl
                      startupParams:
                        type: 'null'
                      cookies:
                        type: 'null'
                      advancedSetting:
                        type: object
                        properties: {}
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/env/advanced/ua/versions:
    get:
      summary: Get a list of browser kernel versions
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        browserType:
                          type: integer
                        versions:
                          type: array
                          items:
                            type: integer
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/env/advanced/ua/get:
    post:
      summary: Get browser profile UA
      operationId: getBrowserProfileUAUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - os
              properties:
                os:
                  type: integer
                  description: |
                    Operating system type.
                    1 = Windows, 2 = macOS, 3 = Android, 4 = iOS
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  example: 1
                osVersion:
                  type: string
                  description: |
                    OS version (e.g., "Windows 11", "macOS 14").
                  example: Windows 11
                vendor:
                  type: integer
                  description: |
                    Browser type.
                    1 = Chrome, 2 = Firefox
                  enum:
                    - 1
                    - 2
                  example: 1
            example:
              os: 1
              osVersion: Windows 11
              vendor: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  data:
                    type: 'null'
                  resolution:
                    type: object
                    properties:
                      id:
                        type: string
                      value:
                        type: string
                    required:
                      - id
                      - value
                  ua:
                    type: string
                  requestId:
                    type: string
                  error:
                    type: object
                    properties: {}
                required:
                  - resolution
                  - ua
          headers: {}
      security: []
  /api/env/base/resolution/list:
    post:
      summary: Get resolution
      operationId: listResolutionsUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                os:
                  type: integer
                  description: OS type (1=Windows, 2=macOS, 3=Android, 4=iOS)
                  example: 1
                ua:
                  type: string
                  description: User-Agent string (optional)
                  example: ''
              required:
                - os
            example:
              os: 1
              ua: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        value:
                          type: string
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/system/platform/list:
    get:
      summary: Get configurable platforms
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Platform ID
                        categoryId:
                          type: string
                          description: Category ID
                        groupName:
                          type: string
                          description: Group name
                        groups:
                          type: string
                          description: Group，0：Amazon
                        isCustomer:
                          type: boolean
                          description: Whether to customize the platform
                        logo:
                          type: string
                          description: Platform logo
                        name:
                          type: string
                          description: Platform name
                        orderNo:
                          type: string
                          description: Sort Number
                        sites:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Site ID
                              host:
                                type: string
                                description: Site Domain Name
                              name:
                                type: string
                                description: Size name
                              nameBak:
                                type: string
                                description: Size name backup
                              logo:
                                type: string
                                description: Logo
                              url:
                                type: string
                                description: Size URL
                              isDefault:
                                type: boolean
                              country:
                                type: string
                                description: Country
                            required:
                              - id
                              - host
                              - name
                              - logo
                              - nameBak
                              - url
                              - isDefault
                              - country
                          description: Sites information
                      required:
                        - id
                        - categoryId
                        - groupName
                        - groups
                        - isCustomer
                        - logo
                        - name
                        - orderNo
                        - sites
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/env/lock/query:
    post:
      summary: Get browser security lock status
      operationId: queryBrowserLockStatusUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - envId
              properties:
                envId:
                  type: string
                  description: Unique environment (browser profile) ID
                  example: '1869988538611834880'
            example:
              envId: '1869988538611834880'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      envId:
                        type: string
                      locked:
                        type: boolean
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/env/base/list:
    post:
      summary: Get a list of timezone and language
      operationId: listTimezoneAndLanguageUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - os
              properties:
                os:
                  type: integer
                  description: |
                    Operating system type.
                    1 = Windows, 2 = macOS, 3 = Android, 4 = iOS
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  example: 1
            example:
              os: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      time_zone_list:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            value:
                              type: string
                      language_list:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            value:
                              type: string
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/env/removeLocalCache:
    post:
      summary: Clear local profile cache
      operationId: clearLocalProfileCacheUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - envId
              properties:
                envId:
                  type: string
                  description: >
                    Environment ID. Exactly one of `envId` or `uniqueId` must be
                    provided.
                localStorage:
                  type: boolean
                  description: Clear LocalStorage Default:false
                  Default: false
                indexedDB:
                  type: boolean
                  description: Clear IndexedDB Default:false
                  Default: false
                cookie:
                  type: boolean
                  description: Clear cookies Default:false
                  Default: false
                extension:
                  type: boolean
                  description: |
                    Clear extension data. If `extensionFile` is not provided,
                    clears both extension name and data. Default:false
                  Default: false
                extensionFile:
                  type: boolean
                  description: |
                    Clear extension files (effective from v3.36).
                  Default: false
            example:
              envId: '1924340272932134912'
              localStorage: false
              indexedDB: false
              cookie: false
              extension: false
              extensionFile: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      envId:
                        type: string
                      requestId:
                        type: string
          headers: {}
      security: []
  /api/env/fingerprint/refresh:
    post:
      summary: Refresh fingerprint
      operationId: refreshFingerprintUsingPOST
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - envId
              properties:
                envId:
                  type: string
                  description: >
                    Profile ID (environment ID). Exactly one of `envId` or
                    `uniqueId` must be provided.
                uniqueId:
                  type: string
                  description: >
                    Profile serial number (unique ID). Exactly one of `envId` or
                    `uniqueId` must be provided.
                uaVersion:
                  type: integer
                  description: |
                    Target User-Agent version (e.g., Chrome 129). 
                    If omitted, uses the current UA version from the profile.
                  example: 129
                browserTypeId:
                  type: integer
                  description: |
                    Browser type. 1 = Chrome, 2 = Firefox.
                  enum:
                    - 1
                    - 2
                operatorSystemId:
                  type: integer
                  description: >
                    Operating system type. 1 = Windows, 2 = macOS, 3 = Android,
                    4 = iOS.
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                advancedSetting:
                  $ref: '#/components/schemas/AdvancedSetting'
            example:
              envId: '1869988538611834880'
              uniqueId: ''
              uaVersion: 129
              browserTypeId: 1
              operatorSystemId: 2
              advancedSetting: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: 'null'
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/env/status:
    post:
      summary: Get the browser profile running status
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                envId:
                  description: Browser environment ID
                  type: string
              required:
                - envId
            example:
              envId: '1957985601221750784'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      envId:
                        type: string
                        description: env Id
                      status:
                        type: string
                      localStatus:
                        type: string
                      debugPort:
                        type: string
                      webdriver:
                        type: string
                    required:
                      - envId
                      - debugPort
                      - status
                      - localStatus
                      - webdriver
                required:
                  - code
                  - msg
                  - data
          headers: {}
      security: []
  /api/env/base/mobile/devices:
    post:
      summary: Get Phone Model List
      deprecated: false
      description: ''
      tags:
        - Browser Profile
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/browser phone list'
          headers: {}
      security: []
  /api/cloudphone/uploadFile:
    post:
      summary: Uploading files
      deprecated: false
      description: ''
      operationId: fileUploadUsing
      tags:
        - Cloud Phone/File Management
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  format: binary
                  type: string
                  description: File to upload
                  examples:
                    - file://D:\application\apifox\LICENSE.electron.txt
                  example: file://D:\application\apifox\LICENSE.electron.txt
                id:
                  description: Cloud phone ID
                  type: string
                  examples:
                    - '1661515884160372'
                  example: '1661515884160372'
                uploadDest:
                  description: Upload destination directory
                  type: string
                  examples:
                    - /Download
                  example: /Download
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
      security: []
  /api/cloudphone/uploadUrl:
    post:
      summary: Uploading file result
      deprecated: false
      description: ''
      operationId: fileUploadUsingPOST
      tags:
        - Cloud Phone/File Management
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                id:
                  description: Cloud phone ID
                  type: string
                  example: '1661515884160372'
                fileId:
                  description: Upload Cloud Phone File ID
                  type: string
                  example: /sdcard/Download
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Return result code 0:Normal Other codes are exceptions.
                  msg:
                    type: string
                    description: |
                      error message
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Cloud phone ID
                      fileId:
                        type: string
                        description: Cloud Phone File ID
                      status:
                        type: integer
                        description: >
                          Upload status: 0 uploading, 1 upload successful, 2
                          upload failed
                    required:
                      - id
                      - fileId
                      - status
                  requestId:
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                id: '1595543947673700'
                fileId: '1292831'
          headers: {}
      security: []
  /api/cloudphone/setKeyBox:
    post:
      summary: Set Keybox
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/File Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filePath:
                  type: string
                  description: File path, e.g., /sdcard/Download/xxx.xml
                id:
                  type: integer
                  description: Cloud phone ID
            example:
              filePath: ''
              id: 0
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: 'Response code: 0 = success, >0 = error'
                  msg:
                    type: string
                  data:
                    type: boolean
          headers: {}
      security: []
  /api/cloudphone/app/install:
    post:
      summary: Install app on cloud phone
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/App Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appVersionId:
                  description: App version ID
                  type: string
                id:
                  description: Cloud phone ID
                  type: integer
                packageName:
                  description: Package name — required only if appVersionId is not provided
                  type: string
                versionCode:
                  description: Version code — required only if appVersionId is not provided
                  type: integer
              required:
                - id
            example:
              appVersionId: '1672940217990530'
              id: 1673823102599682
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: boolean
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/cloudphone/app/page:
    post:
      summary: Get APP application list
      deprecated: false
      description: Fetch APP application list
      tags:
        - Cloud Phone/App Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appName:
                  description: App name (partial match)
                  type: string
                pageNum:
                  description: Page number; Default:1
                  type: integer
                pageSize:
                  description: Items per page; Default:10
                  type: integer
            example:
              appName: de
              pageNum: 1
              pageSize: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: object
                    properties:
                      total:
                        type: string
                      current:
                        type: string
                      pages:
                        type: string
                      dataList:
                        type: array
                        items:
                          type: object
                          properties: {}
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/cloudphone/app/installedList:
    post:
      summary: Query installed apps list
      deprecated: false
      description: Query list of installed apps on a cloud phone
      tags:
        - Cloud Phone/App Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Cloud phone ID
                  type: integer
              required:
                - id
            example:
              id: 1674550360293464
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: 'null'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        appName:
                          type: string
                        appIcon:
                          type: string
                        packageName:
                          type: string
                        versionCode:
                          type: string
                        versionName:
                          type: string
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/cloudphone/app/start:
    post:
      summary: Launch APP
      deprecated: false
      description: Launch an installed app on the cloud phone
      tags:
        - Cloud Phone/App Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Cloud phone ID
                  type: integer
                packageName:
                  description: App package name
                  type: string
              required:
                - id
                - packageName
            example:
              id: 1674550360293464
              packageName: com.depop
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  data:
                    type: 'null'
                  requestId:
                    type: string
          headers: {}
      security: []
  /api/cloudphone/app/restart:
    post:
      summary: Restart APP
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/App Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: Cloud phone ID
                packageName:
                  type: string
                  description: App package name
            example:
              id: 0
              packageName: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: 'Response code: 0 = success, >0 = error'
                  msg:
                    type: string
                    description: Response msg, Error message returned if code > 0
                  data:
                    type: boolean
                required:
                  - msg
          headers: {}
      security: []
  /api/cloudphone/app/stop:
    post:
      summary: Stop APP
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/App Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: Cloud phone ID
                packageName:
                  type: string
                  description: App package name
            example:
              id: 0
              packageName: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: 'Response code: 0 = success, >0 = error'
                  data:
                    type: boolean
                  msg:
                    type: string
                    description: Message; populated if code > 0
          headers: {}
      security: []
  /api/cloudphone/app/uninstall:
    post:
      summary: Uninstall APP
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/App Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: Cloud phone ID
                packageName:
                  type: string
                  description: App package name
            example:
              id: 0
              packageName: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: 'Response code: 0 = success, >0 = error'
                  data:
                    type: boolean
                  msg:
                    type: string
                    description: Message; populated if code > 0
          headers: {}
      security: []
  /api/cloudphone/page:
    post:
      summary: Getting a list of cloud phone profiles
      operationId: pageUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bindIp:
                  type: boolean
                  description: 'Whether IP is bound: true = bound, false = not'
                  example: false
                keyword:
                  type: string
                  description: >-
                    Keyword to filter: proxy info, group name, tag name,
                    environment name
                  example: CP-424
                pageNo:
                  type: integer
                  format: int64
                  description: Current page
                  example: 1
                pageSize:
                  type: integer
                  format: int64
                  description: Items per page
                  example: 100
                sort:
                  type: array
                  description: >-
                    Dynamic sort fields. Currently only "envName" is supported
                    for cloud phones.
                  items:
                    type: object
                    properties:
                      sortDirection:
                        type: string
                        enum:
                          - asc
                          - desc
                        description: Sort direction
                        example: asc
                      sortField:
                        type: string
                        description: >-
                          Field to sort by (only "envName" is currently
                          supported)
                        example: envName
                    required:
                      - sortDirection
                      - sortField
                  example:
                    - sortDirection: asc
                      sortField: envName
              example:
                bindIp: false
                keyword: CP-424
                pageNo: 1
                pageSize: 100
                sort:
                  - sortDirection: asc
                    sortField: envName
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Return result code 0:Normal Other codes are exceptions.
                  msg:
                    type: string
                    description: error message
                  data:
                    type: object
                    properties:
                      current:
                        type: integer
                      dataList:
                        type: array
                        items:
                          $ref: '#/components/schemas/CloudPhoneProfile'
                      pages:
                        type: integer
                      total:
                        type: integer
                    required:
                      - current
                      - dataList
                      - pages
                      - total
                  requestId:
                    type: string
                    description: Operation Request ID
                required:
                  - code
                  - msg
                  - data
                  - requestId
  /api/cloudphone/create:
    post:
      summary: Creating a Cloud Phone Profile
      operationId: createUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                skuId:
                  type: string
                  description: >
                    Cloud Phone model

                    skuId:10002 model:Android 12

                    skuId:10013 model:Android 13

                    skuId:10005 model:Android 14

                    skuId:10004 model:Android 15

                    skuId:10014 model:Android 15A

                    Refer to the appendix for a detailed description of the
                    model's parameters
                quantity:
                  type: integer
                  minimum: 1
                  maximum: 10
                  description: Number of cloud phone created. Range of values:[1-10]
                envRemark:
                  type: string
                  maxLength: 1500
                  description: Profile Remarks (Length limit 1500 characters)
                automaticGeo:
                  type: boolean
                  description: >-
                    Whether to automatically match the geographic location.
                    Default:true
                automaticLanguage:
                  type: boolean
                  description: Whether to automatically match the language. Default:true
                automaticLocation:
                  type: boolean
                  description: >-
                    Whether to auto-match location (time zone, country).
                    Default:true
                country:
                  type: string
                  description: Country, e.g. us. Check appendix for country code details
                timezone:
                  type: string
                  description: Time zone, e.g. America/New_York
                language:
                  type: string
                  description: Language, e.g. en-US
                altitude:
                  type: integer
                latitude:
                  type: number
                  description: Latitude. Example:22.309182
                longitude:
                  type: number
                  description: Longitude. Example:114.176817
                proxyId:
                  type: integer
                  format: int64
                  description: Proxy ID
              required:
                - skuId
                - quantity
                - altitude
              example:
                skuId: '10002'
                envRemark: Remark added at creation
                groupId: '1565859744475508'
                automaticGeo: false
                automaticLanguage: false
                automaticLocation: false
                country: au
                timezone: Australia/Currie
                language: de-AT
                altitude: 1980
                latitude: 83.73
                longitude: 106.49
                proxyId: 1634660919386770
                quantity: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                    nullable: true
                  data:
                    type: array
                    items:
                      type: string
                  requestId:
                    type: string
                  error:
                    type: object
                    properties: {}
                required:
                  - code
                  - msg
                  - requestId
  /api/cloudphone/powerOn:
    post:
      summary: Startup cloud phone
      operationId: powerOnUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
              required:
                - id
            example:
              id: 1637226321190925
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Return result code 0:Normal Other codes are exceptions.
                  msg:
                    type: string
                    description: Error message
                  requestId:
                    type: string
                    description: Operation Request ID
                required:
                  - code
                  - msg
                  - requestId
  /api/cloudphone/powerOff:
    post:
      summary: Shut down the cloud phone
      operationId: powerOffUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
              required:
                - id
            example:
              id: 1596527092376632
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Return result code 0:Normal Other codes are exceptions.
                  msg:
                    type: string
                    description: Error message
                  requestId:
                    type: string
                    description: Operation Request ID
                required:
                  - code
                  - msg
                  - requestId
  /api/cloudphone/edit/batch:
    post:
      summary: Modify the cloud phone profile
      operationId: editBatchUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: Cloud phone IDs
                proxyId:
                  type: integer
                  format: int64
                  description: Proxy ID
                groupId:
                  type: integer
                  format: int64
                  description: Environment group ID
                tagIds:
                  type: array
                  items:
                    type: integer
                    format: int64
                  description: Environment tag IDs
                tagOps:
                  type: string
                  enum:
                    - ADD
                    - UPDATE
                    - CLEAR
                  description: Tag operation
                envRemark:
                  type: string
                  maxLength: 1500
                  description: Environment remark (≤1500 chars, line breaks supported)
                automaticGeo:
                  type: boolean
                  description: Auto geolocation
                automaticLanguage:
                  type: boolean
                  description: Auto language
                automaticLocation:
                  type: boolean
                  description: Auto location (timezone & country)
                country:
                  type: string
                  description: Country
                timezone:
                  type: string
                  description: Timezone
                language:
                  type: string
                  description: Language
                altitude:
                  type: number
                  description: Altitude
                latitude:
                  type: number
                  description: Latitude
                longitude:
                  type: number
                  description: Longitude
              required:
                - id
            example:
              id:
                - 1637238770951311
              proxyId: 0
              automaticGeo: false
              automaticLanguage: false
              automaticLocation: false
              country: bo
              timezone: America/La_Paz
              language: de-CH
              latitude: 0
              longitude: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Return result code:0,Normal Other codes are exceptions.
                  msg:
                    type: string
                    description: Error message
                  requestId:
                    type: string
                    description: Operation Request ID
                required:
                  - code
                  - msg
                  - requestId
  /api/cloudphone/delete/batch:
    post:
      summary: Delete cloud phone profile
      operationId: deleteUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: string
              required:
                - ids
            example:
              ids:
                - '1595755686723985'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Return result code 0:Normal Other codes are exceptions.
                  msg:
                    type: string
                    description: Error message
                  requestId:
                    type: string
                    description: Operation Request ID
                required:
                  - code
                  - msg
                  - requestId
  /api/cloudphone/newMachine:
    post:
      summary: One-click new cloud phone
      operationId: oneNewUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
                  description: Cloud phone ID
                brand:
                  type: string
                  description: Brand
                modelId:
                  type: integer
                  description: Model ID
            example:
              id: 1595372958075305
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code:0 indicates success, >0 indicates failure
                  msg:
                    type: string
                required:
                  - code
                  - msg
  /api/cloudphone/info:
    post:
      summary: Cloud phone - single device details
      operationId: infoUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
                  description: Cloud phone ID
              required:
                - id
            example:
              id: 1672532391231745
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 0
                  msg:
                    type: string
                    nullable: true
                    example: null
                  data:
                    $ref: '#/components/schemas/CloudPhoneDetail'
                  requestId:
                    type: string
                    example: 4d0f4fa68613441e9a11446a6437bb5a
                required:
                  - code
                  - msg
                  - data
                  - requestId
  /api/cloudphone/brand/models:
    post:
      summary: Query brand & model list
      description: Query available brand & model list for given Android version
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                skuId:
                  type: integer
                  description: Cloud phone product ID
              required:
                - skuId
            example:
              skuId: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  msg:
                    type: string
                  requestId:
                    type: string
                  timestamp:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        brand:
                          type: string
                        model:
                          type: string
  /api/cloudphone/updateAdb:
    post:
      summary: Update cloud phone ADB status
      operationId: updateAdbUsingPOST
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enableAdb:
                  type: boolean
                ids:
                  type: array
                  items:
                    type: integer
                    format: int64
              required:
                - enableAdb
                - ids
            example:
              enableAdb: true
              ids:
                - 1633612946805630
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Return result code 0:Normal Other codes are exceptions.
                  msg:
                    type: string
                    description: Error message
                  requestId:
                    type: string
                    description: Operation Request ID
                required:
                  - code
                  - msg
                  - requestId
  /api/cloudphone/exeCommand:
    post:
      summary: Execute shell command
      operationId: executeShellCommand
      tags:
        - Cloud Phone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
                  description: Cloud phone ID
                command:
                  type: string
                  description: Shell command to execute
              required:
                - id
                - command
            example:
              command: >-
                am start -n
                com.android.chrome/com.google.android.apps.chrome.Main
              id: 1674153897828425
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: 'Response code: 0 indicates success, >0 indicates failure'
                  data:
                    type: string
                    description: Response Information
                  msg:
                    type: string
                    description: >-
                      Response message:An error message will be returned when
                      code is greater than 0
                required:
                  - code
                  - data
                  - msg
  /api/cloudphone/rpa/template/market/page:
    post:
      summary: Get market template pages
      deprecated: false
      description: Query Schedules market template, template name supports fuzzy query
      tags:
        - Cloud Phone/Schedules management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                searchKey:
                  type: string
                  description: Template Name
                  nullable: true
                pageNo:
                  type: integer
                  description: Default:1
                  nullable: true
                pageSize:
                  type: integer
                  description: Default:10
                  nullable: true
            example:
              pageNo: 0
              pageSize: 0
              searchWords: ''
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                  data:
                    type: object
                    properties:
                      dataList:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                              description: Market template title
                            parameter:
                              type: string
                              description: Template parameter JSON string
                            description:
                              type: string
                              description: Market template Description
                            appIconUrls:
                              type: array
                              items:
                                type: string
                            sort:
                              type: integer
                              description: sort
                            author:
                              type: string
                              description: author
                            updateDate:
                              type: string
                              description: Last update time
                          required:
                            - parameter
                      current:
                        type: integer
                        description: Current page number
                      pages:
                        type: integer
                        description: Total pages
                      total:
                        type: integer
                        description: Total count
                    required:
                      - current
                      - dataList
                      - pages
                      - total
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data:
                  current: 0
                  dataList:
                    - appIconUrls: []
                      author: ''
                      description: ''
                      parameter: ''
                      id: 0
                      sort: 0
                      title: ''
                      type: 0
                      updateDate: ''
                  pages: 0
                  total: 0
          headers: {}
      security: []
  /api/cloudphone/rpa/template/personal/page:
    post:
      summary: Get Personal template pages
      deprecated: false
      description: Query Schedules market template, template name supports fuzzy query
      tags:
        - Cloud Phone/Schedules management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                searchKey:
                  type: string
                  description: Template name
                  nullable: true
                desc:
                  type: string
                  description: Template description
                pageNo:
                  type: integer
                  description: Default:1
                  nullable: true
                pageSize:
                  type: integer
                  description: Default:10
                  nullable: true
            example:
              pageNo: 1
              pageSize: 10
              searchWords: ''
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                  data:
                    type: object
                    properties:
                      dataList:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                              description: Market template title
                            parameter:
                              type: string
                              description: Template parameter JSON string
                            description:
                              type: string
                              description: Market template Description
                            appIconUrls:
                              type: array
                              items:
                                type: string
                            sort:
                              type: integer
                              description: sort
                            updateDate:
                              type: string
                              description: Last update time
                      current:
                        type: integer
                        description: Current page number
                      pages:
                        type: integer
                        description: Total pages
                      total:
                        type: integer
                        description: Total count
                    required:
                      - current
                      - dataList
                      - pages
                      - total
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data:
                  current: 0
                  dataList:
                    - id: 0
                      title: ''
                      appIconUrls: []
                      author: ''
                      description: ''
                      parameter: ''
                      sort: 0
                      updateDate: ''
                  pages: 0
                  total: 0
          headers: {}
      security: []
  /api/cloudphone/rpa/task/page:
    post:
      summary: Get a schedules list
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/Schedules management
      parameters:
        - name: enabled
          in: query
          description: Is the plan enabled
          required: false
          example: 'false'
          schema:
            type: boolean
            nullable: true
        - name: mainTaskName
          in: query
          description: plan name
          required: false
          schema:
            type: string
            maxLength: 150
            minLength: 1
            nullable: true
        - name: taskState
          in: query
          description: >-
            Plan status; 0:awaiting execution; 1:Executing; 2:Execution
            completed 3:Cancel
          required: false
          schema:
            type: integer
            maximum: 3
            nullable: true
        - name: templateTitle
          in: query
          description: Template Title
          required: false
          schema:
            type: string
            maxLength: 150
            minLength: 0
            nullable: true
        - name: pageNo
          in: query
          description: default:1
          required: false
          schema:
            type: string
        - name: pageSize
          in: query
          description: default:20
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Is the plan enabled
                  nullable: true
                taskName:
                  type: string
                  description: Plan name
                  nullable: true
                templateTitle:
                  type: string
                  description: Template title
                  nullable: true
                taskState:
                  type: integer
                  description: >
                    Schedule status; 0:awaiting execution; 1:Executing;
                    2:Execution completed 3:Cancel
                  nullable: true
                pageNo:
                  type: integer
                  description: default:1
                  nullable: true
                pageSize:
                  type: integer
                  description: default:10
                  nullable: true
            example: |-
              {
                  "pageNo": 1,
                  "pageSize": 10,
              }
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                  data:
                    type: object
                    properties:
                      dataList:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Schedule id
                            taskName:
                              type: string
                              description: Schedule Task name
                            createMember:
                              type: string
                              description: Member name
                            enabled:
                              type: boolean
                              description: Whether enabled
                            endTime:
                              type: string
                              description: Task end time
                            failCount:
                              type: integer
                              description: Number of failed executions
                            handleTime:
                              type: string
                              description: Execution start time
                            notes:
                              type: string
                              description: schedule notes
                            scheduleConfig:
                              type: string
                              description: Task schedule configuration
                            successCount:
                              type: integer
                              description: Number of successful executions
                            taskPreviewTimeTable:
                              type: array
                              items:
                                type: object
                                properties:
                                  cloudPhoneId:
                                    type: integer
                                    description: Cloud phone ID
                                  cloudPhoneName:
                                    type: string
                                    description: Cloud phone name
                                  times:
                                    type: array
                                    items:
                                      type: string
                                    description: List of execution times
                            taskState:
                              type: integer
                              description: >-
                                Schedule Task state. 0:waiting; 1:running;
                                2:completed 3:Cancel
                            templateId:
                              type: integer
                              description: Template id
                            templateTitle:
                              type: string
                              description: Template title
                          required:
                            - createMember
                        description: Plan list
                      current:
                        type: integer
                        description: Current page number
                      pages:
                        type: integer
                        description: Total pages
                      total:
                        type: integer
                        description: Total count
                    required:
                      - current
                      - dataList
                      - pages
                      - total
                required:
                  - code
                  - data
                  - msg
                  - requestId
              example:
                code: 0
                data:
                  current: 0
                  dataList:
                    - createMember: ''
                      enabled: true
                      endTime: ''
                      failCount: 0
                      handleTime: ''
                      id: 0
                      notes: ''
                      scheduleConfig: ''
                      successCount: 0
                      taskName: ''
                      taskPreviewTimeTable:
                        - billingType: 0
                          cloudPhoneId: 0
                          cloudPhoneName: ''
                          times:
                            - ''
                      taskState: 0
                      templateId: 0
                      templateTitle: ''
                  pages: 0
                  total: 0
                msg: ''
          headers: {}
      security: []
  /api/cloudphone/rpa/task/save:
    post:
      summary: Creating a schedule
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/Schedules management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                taskName:
                  type: string
                  description: Task name
                templateId:
                  type: integer
                  description: Template ID
                templateType:
                  type: string
                  description: Template type. PERSONAL:personal; MARKET:marketplace
                taskType:
                  type: string
                  description: Task type. TEMPORARY or SCHEDULED
                notes:
                  type: string
                  description: Plan notes
                cloudPhoneConfigs:
                  type: array
                  items:
                    type: object
                    properties:
                      cloudPhoneId:
                        type: integer
                        description: Cloud phone ID
                      triggerTime:
                        type: string
                        description: Task execution time, UTC+0 time zone
                      templateParameter:
                        type: string
                        description: Template parameters
                    required:
                      - cloudPhoneId
                      - triggerTime
                      - templateParameter
                  description: Collection of cloud phone schedule configurations
                scheduleConfig:
                  type: object
                  properties:
                    endTime:
                      type: string
                      description: date-time
                    scheduleType:
                      type: string
                      description: Schedule type. ONCE:one-time; DAILY:daily; WEEKLY:weekly
                    timezone:
                      type: string
                      description: Timezone
                  required:
                    - endTime
                    - scheduleType
                    - timezone
                  description: Task schedule configuration
              required:
                - cloudPhoneConfigs
                - scheduleConfig
                - taskName
                - taskType
                - templateId
                - templateType
            example:
              cloudPhoneConfigs:
                - cloudPhoneId: 1678331966138097
                  templateParameter:
                    keyword: abc
                  triggerTime: '2025-12-29 23:00:00'
              notes: notes test
              scheduleConfig:
                endTime: '2025-12-30 00:00:00'
                scheduleType: ONCE
              taskName: test
              templateId: 1678347487160296
              templateType: PERSONAL
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                  data:
                    type: integer
                    description: Schedules id
                required:
                  - code
                  - data
                  - msg
                  - requestId
              example:
                code: 0
                data: 0
                msg: ''
          headers: {}
      security: []
  /api/cloudphone/rpa/task/cancel:
    post:
      summary: Cancel schedule
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/Schedules management
      parameters:
        - name: id
          in: query
          description: ''
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: Plan id
              required:
                - id
            example:
              id: 1678919049331329
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                required:
                  - code
                  - data
                  - msg
                  - requestId
              example:
                code: 0
                data: null
                msg: ''
          headers: {}
      security: []
  /api/cloudphone/rpa/subTask/page:
    post:
      summary: Page query task executions record
      deprecated: false
      description: Query Schedules market template, template name supports fuzzy query
      tags:
        - Cloud Phone/Schedules management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                taskId:
                  type: integer
                  description: Task id
                  nullable: true
                taskName:
                  type: string
                  description: Task name
                  maxLength: 255
                  minLength: 1
                  nullable: true
                taskState:
                  type: integer
                  description: >-
                    Plan status; 0:awaiting execution; 1:Executing; 2:Execution
                    completed 3:Cancel
                  maximum: 9
                  minimum: 0
                  nullable: true
                templateId:
                  type: integer
                  description: Template id
                  maximum: 99999999999
                  minimum: 0
                  nullable: true
                templateTitle:
                  type: string
                  description: Template title
                  maxLength: 255
                  minLength: 0
                  nullable: true
                cloudPhoneId:
                  type: integer
                  description: cloud phone id
                  nullable: true
                  example: 1559133625483282
                cloudPhoneName:
                  type: string
                  description: Cloud phone name
                  maxLength: 100
                  minLength: 0
                  nullable: true
                beginTime:
                  type: string
                  description: Task start time UTC+0 time zone
                  nullable: true
                  example: '2025-01-01 23:59:59'
                endTime:
                  type: string
                  description: |
                    Task end time UTC+0 time zone
                  nullable: true
                  example: '2025-01-02 23:59:59'
                pageNo:
                  type: integer
                  description: Default:1
                  nullable: true
                  example: 1
                pageSize:
                  type: integer
                  description: Default:10
                  nullable: true
            example:
              pageNo: 1
              pageSize: 10
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                  data:
                    type: object
                    properties:
                      dataList:
                        type: array
                        items:
                          $ref: '#/components/schemas/Execution DTO'
                      current:
                        type: integer
                        description: Current page number
                      pages:
                        type: integer
                        description: Total pages
                      total:
                        type: integer
                        description: Total count
                    required:
                      - current
                      - dataList
                      - pages
                      - total
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data:
                  current: 0
                  dataList:
                    - appIconUrls: []
                      author: ''
                      description: ''
                      id: 0
                      sort: 0
                      title: ''
                      type: 0
                      updateDate: ''
                  pages: 0
                  total: 0
          headers: {}
      security: []
  /api/cloudphone/rpa/subTask/detail/{id}:
    post:
      summary: Get a task execution
      deprecated: false
      description: Query Schedules market template, template name supports fuzzy query
      tags:
        - Cloud Phone/Schedules management
      parameters:
        - name: id
          in: path
          description: Execution task id
          required: true
          example: 1678919049331331
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                taskId:
                  type: integer
                  description: Task id
                  nullable: true
                taskName:
                  type: string
                  description: Task name
                  maxLength: 255
                  minLength: 1
                  nullable: true
                taskState:
                  type: integer
                  description: >-
                    Plan status; 0:awaiting execution; 1:Executing; 2:Execution
                    completed 3:Cancel
                  maximum: 9
                  minimum: 0
                  nullable: true
                templateId:
                  type: integer
                  description: Template id
                  maximum: 99999999999
                  minimum: 0
                  nullable: true
                templateTitle:
                  type: string
                  description: Template title
                  maxLength: 255
                  minLength: 0
                  nullable: true
                cloudPhoneId:
                  type: integer
                  description: cloud phone id
                  nullable: true
                  example: 1559133625483282
                cloudPhoneName:
                  type: string
                  description: Cloud phone name
                  maxLength: 100
                  minLength: 0
                  nullable: true
                beginTime:
                  type: string
                  description: Task start time UTC+0 time zone
                  nullable: true
                  example: '2025-01-01 23:59:59'
                endTime:
                  type: string
                  description: |
                    Task end time UTC+0 time zone
                  nullable: true
                  example: '2025-01-02 23:59:59'
                pageNo:
                  type: integer
                  description: Default:1
                  nullable: true
                  example: 1
                pageSize:
                  type: integer
                  description: Default:10
                  nullable: true
            example: ''
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Execution record id
                      taskName:
                        type: string
                        description: Schedule Task name
                      taskState:
                        type: integer
                        description: >-
                          Schedule status; 0:awaiting execution; 1:Executing;
                          2:Execution completed 3:Cancel
                      cloudPhoneId:
                        type: integer
                        description: Cloud phone ID
                      cloudPhoneName:
                        type: string
                        description: Cloud phone name
                      templateName:
                        type: string
                        description: Template title
                      handleFailCode:
                        type: string
                        description: Task failure code
                      handleFailReason:
                        type: string
                        description: Task failure reason
                      handleResult:
                        type: integer
                        description: Task result. 0:failed; 1:succeeded
                      handleResultAttachment:
                        type: string
                        description: Task execution result attachment
                      handleTime:
                        type: string
                        description: Execution time
                      endTime:
                        type: string
                        description: Task end time
                      powerOnTime:
                        type: string
                        description: Cloud phone power-on time
                      triggerNextTime:
                        type: string
                        description: Next scheduled trigger time
                      triggerTime:
                        type: string
                        description: Scheduled trigger time
                      createDate:
                        type: string
                        description: Creation time
                      createMember:
                        type: string
                        description: Creator
                      updateDate:
                        type: string
                        description: Last update time
                      updateMember:
                        type: string
                        description: Last updater
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data:
                  current: 0
                  dataList:
                    - appIconUrls: []
                      author: ''
                      description: ''
                      id: 0
                      sort: 0
                      title: ''
                      type: 0
                      updateDate: ''
                  pages: 0
                  total: 0
          headers: {}
      security: []
  /api/cloudphone/rpa/subTask/cancel/{id}:
    post:
      summary: Cancel execution
      deprecated: false
      description: ''
      tags:
        - Cloud Phone/Schedules management
      parameters:
        - name: id
          in: path
          description: ''
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  description: Plan id
              required:
                - id
            example:
              id: 1678919049331329
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: Response code, 0 indicates success,>0 indicates failure
                  msg:
                    type: string
                    description: Error msg
                  requestId:
                    type: string
                    description: Request trace id
                required:
                  - code
                  - data
                  - msg
                  - requestId
              example:
                code: 0
                data: null
                msg: ''
          headers: {}
      security: []
  /api/proxyInfo/page:
    post:
      summary: Getting a list of proxies
      deprecated: false
      description: ''
      operationId: queryProxyInfoPageUsingPOST
      tags:
        - Proxy Management
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pageNo:
                  type: integer
                  description: Current page number (starts from 1)
                  example: 1
                pageSize:
                  type: integer
                  description: Number of items per page
                  example: 10
                isCloudPhoneProxy:
                  type: boolean
                  description: >
                    Whether the proxy is for cloud phone usage.

                    - `true`: Exclude local/private IPs (e.g., 127.0.0.1, 360,
                    pia, private ranges)

                    - `false`: Return all proxies
                  example: false
                proxyCategoryType:
                  type: integer
                  description: |
                    Proxy category type:
                    - `1` = Cloud platform
                    - `2` = Self-owned IP
                  example: 2
                proxyIp:
                  type: string
                  description: Filter by proxy IP address (partial match)
                  example: ''
                proxyName:
                  type: string
                  description: Filter by proxy name (partial match)
                  example: ''
                proxyProviders:
                  type: array
                  items:
                    type: integer
                  description: |
                    List of proxy provider IDs. Supported values:
                    - `0` = None
                    - `4` = Oxylabs
                    - `5` = Proxys.io
                    - `6` = GeoSurf
                    - `7` = Luminati
                    - `8` = Lumauto
                    - `9` = Oxylabsauto
                    - `10` = Trojan
                    - `11` = Shadowsocks
                    - `12` = vmess
                    - `13` = ABCPROXY
                    - `14` = LunaProxy
                    - `15` = IPHTML
                    - `16` = PiaProxy
                    - `17` = 922S5
                  example: []
                proxyStatus:
                  type: integer
                  description: |
                    Proxy assignment status:
                    - `0` = Normal
                    - `1` = Unassigned
                    - `2` = Upgrading
                    - `3` = Expired
                    - `4` = Expiring soon  
                    > Note: Self-owned proxies always use status `1`.
                  example: 1
                proxyCheckStatus:
                  type: integer
                  description: |
                    Proxy health check status:
                    - `0` = Pending
                    - `1` = Success
                    - `2` = Failed
                    - `3` = Unknown error
                  example: 1
                proxyTypes:
                  type: array
                  items:
                    type: integer
                  description: |
                    Proxy protocol types:
                    - `0` = HTTP
                    - `1` = HTTPS
                    - `2` = SOCKS5
                    - `3` = SSH
                  example: []
              required: []
            example:
              pageNo: 1
              pageSize: 10
              isCloudPhoneProxy: false
              proxyCategoryType: 2
              proxyIp: ''
              proxyName: ''
              proxyProviders: []
              proxyStatus: 1
              proxyCheckStatus: 1
              proxyTypes: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    type: object
                    properties:
                      current:
                        type: integer
                      dataList:
                        type: array
                        items:
                          type: object
                          properties:
                            expiryTime:
                              description: Expiration time
                              type: integer
                            id:
                              description: Primary key
                              type: integer
                            proxyCategoryType:
                              description: Proxy type 1:Platform proxy; 2:Self-owned proxy
                              type: integer
                            proxyCheckStatus:
                              description: >-
                                Detection status 0-pending detection
                                1-monitoring success 2-detection failure
                                3-unknown error
                              type: integer
                            proxyIp:
                              description: Proxy IP
                              type: string
                            exportIp:
                              description: export IP
                              type: string
                            countryCode:
                              description: countryCode
                              type: string
                            proxyName:
                              description: Proxy Name
                              type: string
                            proxyProvider:
                              description: >
                                Proxy Provider:default value 0 - none 4-Oxylabs
                                5-Proxys.io 7-Luminati 8-Lumauto 9-Oxylabsauto
                                10-Trojan，11-Shadowsocks 13-ABCPROXY
                                14-LunaProxy 15-IPHTML 16-PiaProxy 17-922S5
                              type: integer
                            proxyType:
                              description: Proxy Type:0-http 1-https 2-socks5 3-ssh
                              type: integer
                            username:
                              description: Proxy username
                              type: string
                            password:
                              description: Proxy password
                              type: string
                            refreshUrl:
                              description: Proxy refresh URL
                              type: string
                      pages:
                        type: integer
                      total:
                        type: integer
                    required:
                      - current
                      - dataList
                      - pages
                      - total
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
          headers: {}
      security: []
  /api/proxyInfo/add:
    post:
      summary: Adding proxy
      deprecated: false
      description: ''
      operationId: addUsingPOST
      tags:
        - Proxy Management
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                city:
                  type: string
                  description: City
                  example: ''
                country:
                  type: string
                  description: >
                    Country code (ISO 3166-1 alpha-2). Required only if
                    proxyProvider=17.
                  example: AD
                encryptionType:
                  type: integer
                  format: int32
                  description: Encryption type, valid values are integers from 1 to 14.
                  example: 14
                ipChangeAction:
                  type: integer
                  format: int32
                  description: Action on IP change:0 = Block, 1 = Warn
                  example: 1
                ipMonitor:
                  type: boolean
                  description: Enable IP change monitoring
                  example: false
                password:
                  type: string
                  description: Password for proxy authentication
                  example: ''
                proxyIp:
                  type: string
                  description: Proxy IP address
                  example: 8.10.22.46
                proxyName:
                  type: string
                  description: Proxy name (supports placeholders like {{random}})
                  example: sock5_{{random}}
                proxyPort:
                  type: integer
                  format: int32
                  description: Proxy port number
                  example: 65534
                proxyProvider:
                  type: integer
                  format: int32
                  description: >
                    Proxy provider type:

                    0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH, 4=Oxylabs, ..., 17=922S5.

                    Special rules:

                    - If proxyProvider is 7 or 8, proxyType is required.

                    - If proxyProvider is 17, country is required; state and
                    city are optional.
                  example: 2
                proxyType:
                  type: integer
                  format: int32
                  description: |
                    Proxy protocol type: 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH.
                    Required only when proxyProvider is 7 or 8.
                  example: 1
                refreshUrl:
                  type: string
                  description: URL to refresh dynamic proxy IP (if supported)
                  example: ''
                state:
                  type: string
                  description: State/Province
                  example: ''
                username:
                  type: string
                  description: Username for proxy authentication
                  example: ''
              required:
                - proxyIp
                - proxyPort
                - proxyProvider
            example:
              proxyIp: 8.10.22.46
              proxyPort: 65534
              proxyProvider: 2
              proxyType: 1
              country: AD
              state: ''
              city: ''
              encryptionType: 14
              ipChangeAction: 1
              ipMonitor: false
              proxyName: sock5_{{random}}
              refreshUrl: ''
              username: ''
              password: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    description: Proxy ID
                    type: integer
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data: 0
                requestId: abcd1234
          headers: {}
      security: []
  /api/proxyInfo/update:
    post:
      summary: Modifying proxy information
      deprecated: false
      description: ''
      operationId: updateProxyUsingPOST
      tags:
        - Proxy Management
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - id
                - proxyIp
                - proxyPort
              properties:
                id:
                  type: integer
                  format: int64
                  description: Unique proxy ID
                proxyIp:
                  type: string
                  description: Proxy server IP address
                proxyPort:
                  type: integer
                  description: Proxy server port
                proxyName:
                  type: string
                  description: Custom name for the proxy
                country:
                  type: string
                  description: Country (e.g., "US", "CN")
                city:
                  type: string
                  description: City name
                username:
                  type: string
                  description: Authentication username (if required)
                password:
                  type: string
                  description: Authentication password (if required)
                proxyType:
                  type: integer
                  description: |
                    Proxy protocol type:
                    - `0` = HTTP
                    - `1` = HTTPS
                    - `2` = SOCKS5
                    - `3` = SSH
                proxyProvider:
                  type: integer
                  description: |
                    Proxy provider ID:
                    - `0` = None / Self-owned
                    - `4` = Oxylabs
                    - `5` = Proxys.io
                    - `6` = GeoSurf
                    - `7` = Luminati
                    - `8` = Lumauto
                    - `9` = Oxylabsauto
                    - `10` = Trojan
                    - `11` = Shadowsocks
                    - `12` = vmess
                    - `13` = ABCPROXY
                    - `14` = LunaProxy
                    - `15` = IPHTML
                    - `16` = PiaProxy
                    - `17` = 922S5
                encryptionType:
                  type: integer
                  description: Encryption type (provider-specific, usually 0 for plain)
                ipMonitor:
                  type: boolean
                  description: Enable IP change monitoring
                ipChangeAction:
                  type: integer
                  description: |
                    Action to take when IP changes:
                    - `1` = Notify / Refresh (common value)
                    > Check system documentation for full options.
                refreshUrl:
                  type: string
                  description: URL to trigger IP refresh (if supported by provider)
                state:
                  type: string
                  description: Reserved field or custom state (optional)
            example:
              id: 1566403036579198
              proxyIp: 108.11.23.85
              proxyPort: 4096
              proxyName: MyProxy
              country: US
              city: New York
              username: ''
              password: ''
              proxyType: 0
              proxyProvider: 0
              encryptionType: 0
              ipMonitor: true
              ipChangeAction: 1
              refreshUrl: ''
              state: ''
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - requestId
              example:
                code: 0
                msg: ''
                requestId: efgh5678
          headers: {}
      security: []
  /api/proxyInfo/delete:
    post:
      summary: Delete proxy
      deprecated: false
      description: ''
      operationId: deleteProxyUsingPOST
      tags:
        - Proxy Management
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: integer
                format: int64
            example:
              - 1054661322597744600
              - 1054661322597744600
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - requestId
              example:
                code: 0
                msg: ''
                requestId: ijkl9012
          headers: {}
      security: []
  /api/envgroup/page:
    post:
      summary: Get a list of groups
      deprecated: false
      description: ''
      tags:
        - Group Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                groupName:
                  type: string
                  title: Group name (partial match)
                pageNo:
                  type: integer
                  title: Current page
                pageSize:
                  type: integer
                  title: Items per page
              required:
                - groupName
                - pageNo
                - pageSize
            example:
              groupName: 132-kernel
              pageNo: 1
              pageSize: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    type: object
                    properties:
                      current:
                        type: integer
                      dataList:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              description: Group ID
                              type: integer
                            groupName:
                              description: Group name
                              type: string
                      pages:
                        type: integer
                      total:
                        type: integer
                    required:
                      - current
                      - dataList
                      - pages
                      - total
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data:
                  current: 0
                  dataList:
                    - id: 0
                      groupName: ''
                  pages: 0
                  total: 0
                requestId: ''
          headers: {}
      security: []
  /api/envgroup/edit:
    post:
      summary: Modify grouping information
      deprecated: false
      description: ''
      tags:
        - Group Management
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - groupName
                - id
              properties:
                groupName:
                  type: string
                  description: New name for the environment group
                id:
                  type: integer
                  format: int64
                  description: Unique ID of the group to be updated
            example:
              groupName: Group-1574544945848579
              id: 1574525425557584
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    type: boolean
                    description: result
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data: 0
                requestId: ''
          headers: {}
      security: []
  /api/envgroup/create:
    post:
      summary: Add group
      deprecated: false
      description: ''
      tags:
        - Group Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example:
              groupName: Group-333
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    description: The data returned by the operation
                    type: integer
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data: 0
                requestId: ''
          headers: {}
      security: []
  /api/envgroup/delete:
    post:
      summary: Delete group
      deprecated: false
      description: ''
      tags:
        - Group Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example:
              ids:
                - 1588991461723549
              isDeleteAllEnv: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    type: boolean
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data: true
                requestId: ''
          headers: {}
      security: []
  /api/envtag/all:
    get:
      summary: Getting a list of tags
      deprecated: false
      description: ''
      tags:
        - Tag Management
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: error message
                    type: string
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          description: ID of tags
                          type: integer
                        tagName:
                          description: Name of tags
                          type: string
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data:
                  - id: 0
                    tagName: ''
                requestId: ''
          headers: {}
      security: []
  /api/envtag/create:
    post:
      summary: Create tags
      deprecated: false
      description: ''
      tags:
        - Tag Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example:
              tagName: Tag-123
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: error message
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        description: ID of tags
                        type: integer
                      tagName:
                        description: Name of tags
                        type: string
                    required:
                      - id
                      - tagName
                  requestId:
                    description: Operation Request ID
                    type: string
                  error:
                    type: object
                    properties: {}
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data:
                  id: 0
                  tagName: ''
                requestId: ''
          headers: {}
      security: []
  /api/envtag/edit:
    post:
      summary: Modify information of tags
      deprecated: false
      description: ''
      tags:
        - Tag Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example:
              id: 1564715845550177
              tagName: Updated-123
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    type: boolean
                  requestId:
                    description: Operation Request ID
                    type: string
                  error:
                    type: object
                    properties: {}
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data: true
                requestId: ''
          headers: {}
      security: []
  /api/envtag/delete:
    post:
      summary: Delete tags
      deprecated: false
      description: ''
      tags:
        - Tag Management
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example:
              ids:
                - '1574175499182143'
                - '1574175188803646'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    description: Return result code 0:Normal Other codes are exceptions.
                    type: integer
                  msg:
                    description: Error message
                    type: string
                  data:
                    type: boolean
                  requestId:
                    description: Operation Request ID
                    type: string
                required:
                  - code
                  - msg
                  - data
                  - requestId
              example:
                code: 0
                msg: ''
                data: true
                requestId: ''
          headers: {}
      security: []
webhooks: {}
components:
  schemas:
    start browser profile:
      type: object
      properties:
        envId:
          type: string
          description: profile
        debugPort:
          type: string
        type:
          type: string
        version:
          type: integer
        webdriver:
          type: string
      required:
        - envId
        - debugPort
        - type
        - version
        - webdriver
    UaGet:
      type: object
      properties:
        resolution:
          type: object
          properties:
            id:
              type: string
            value:
              type: string
          required:
            - id
            - value
        ua:
          type: string
      required:
        - resolution
        - ua
    EnvironmentRequest:
      type: object
      properties:
        accountInfo:
          $ref: '#/components/schemas/AccountInfo'
        advancedSetting:
          $ref: '#/components/schemas/AdvancedSetting'
        afterStartupConfig:
          $ref: '#/components/schemas/AfterStartupConfig'
        browserCore:
          type: integer
          description: >-
            Kernel version; default:0 (auto-match). Fetch available versions via
            `/api/env/advanced/ua/versions`.
        cookies:
          type: string
          description: Cookie string to preload (optional)
        envName:
          type: string
          description: Environment name
        envRemark:
          type: string
          description: Environment remark; max length:1500 chars
        groupId:
          type: integer
          description: Environment group ID; default:ungrouped (0)
        envId:
          type: string
          description: Environment ID
        proxyId:
          type: integer
          description: Proxy ID; default:0
        tagIds:
          type: array
          items:
            type: integer
          description: Tag IDs; default:none
        uaVersion:
          type: integer
          description: UA preset version; default:0 (all)
        disableAudio:
          type: integer
          description: Disable audio:0 = off, 1 = on
        disableImg:
          type: integer
          description: Disable image loading:0 = off, 1 = on
        disableVideo:
          type: integer
          description: Disable video loading:0 = off, 1 = on
        imgLimitSize:
          type: integer
          description: Max image size (KB)
    AccountInfo:
      type: object
      properties:
        customerUrl:
          type: string
          description: >-
            Custom platform URL — required if platformId=9999, must be a valid
            URL
        password:
          type: string
          description: Password; max length:50 characters
        platformId:
          type: integer
          description: >-
            Platform ID; use 9999 for custom URL. Refer to
            /api/system/platform/list.
        siteId:
          type: integer
          description: >-
            Site ID; obtain via ""Get Configurable Platforms"" API
            (/api/system/platform/list)
        username:
          type: string
          maxLength: 64
          description: Username; max length:64 characters
    AdvancedSetting:
      type: object
      description: Advanced browser fingerprint and behavior configuration.
      properties:
        ua:
          type: string
          description: >
            Customize the profile User-Agent (UA). Must follow standard UA
            format.

            Available via the “Get Browser UA” API.
        time_zone:
          $ref: '#/components/schemas/TimeZoneConfig'
        web_rtc:
          $ref: '#/components/schemas/WebRTCConfig'
        geo_location:
          $ref: '#/components/schemas/GeoLocationConfig'
        language:
          $ref: '#/components/schemas/LanguageConfig'
        resolution:
          $ref: '#/components/schemas/ResolutionConfig'
        font:
          $ref: '#/components/schemas/FontConfig'
        canvas:
          $ref: '#/components/schemas/CanvasConfig'
        webgl_image:
          $ref: '#/components/schemas/WebGLImageConfig'
        webgl_metadata:
          $ref: '#/components/schemas/WebGLMetadataConfig'
        audio_context:
          $ref: '#/components/schemas/AudioContextConfig'
        media_device:
          $ref: '#/components/schemas/MediaDeviceConfig'
        client_rects:
          $ref: '#/components/schemas/ClientRectsConfig'
        speech_voise:
          $ref: '#/components/schemas/SpeechVoiseConfig'
        hardware_concurrency:
          type: integer
          description: |
            Simulated number of logical CPU cores.
            Default:4. Options: 0 (real), 2, 3, 4, 6, 8, 10, 12.
        memery_device:
          type: integer
          description: |
            Simulated device memory (GB).
            Default:8. Options: 0 (real), 2, 4, 6, 8.
        do_not_track:
          type: integer
          description: Do Not Track setting. Default:2. 1 = on, 2 = off.
        bluetooth:
          $ref: '#/components/schemas/BluetoothConfig'
        battery:
          $ref: '#/components/schemas/BatteryConfig'
        port_scan_protection:
          $ref: '#/components/schemas/PortScanProtectionConfig'
        os_version:
          type: string
          description: macOS system version (e.g., macOS 12, macOS 13, macOS 14).
        web_gpu:
          $ref: '#/components/schemas/WebGPUConfig'
        ciphers:
          $ref: '#/components/schemas/CiphersConfig'
        mobile_device:
          type: string
          description: |
            Phone model ID (as string). Obtain via "Get Phone Model List" API.
            Example: "1826502391344832512"
    TimeZoneConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Timezone option. Default:1. 1 = Match IP, 2 = Custom.
        value:
          type: string
          description: |
            Required when switcher=2.
            Timezone ID from “Get Timezone & Language List” API.
    WebRTCConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: >
            WebRTC policy. Default:2. 1 = Privacy, 2 = Replacement, 3 = Real, 4
            = Disabled, 5 = Forwarding.
    GeoLocationConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Geolocation policy. Default:1. 1 = Prompt, 2 = Disabled.
        base_on_ip:
          type: boolean
          description: >-
            Generate location based on IP? Default:true. true = prompt, false =
            manual.
        latitude:
          type: number
          format: float
          description: Latitude. Required if base_on_ip=false.
        longitude:
          type: number
          format: float
          description: Longitude. Required if base_on_ip=false.
        accuracy:
          type: number
          format: float
          description: Accuracy in meters. Required if base_on_ip=false.
    LanguageConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Language policy. Default:1. 1 = Match IP, 2 = Custom.
        value:
          type: string
          description: >
            Required when switcher=2.

            Comma-separated language IDs from “Get Timezone & Language List”
            API.
    ResolutionConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Resolution policy. Default:1. 1 = Real, 2 = Custom.
        id:
          type: string
          description: |
            Required when switcher=2.
            Resolution ID from “Get Resolution List” API.
    FontConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Font policy. Default:1. 1 = Real, 2 = Custom.
        value:
          type: string
          description: Comma-separated custom font names (required if switcher=2).
    CanvasConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Canvas policy. Default:1. 1 = Noise, 2 = Real.
    WebGLImageConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: WebGL image policy. Default:1. 1 = Noise, 2 = Real.
    WebGLMetadataConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: >-
            WebGL metadata policy. Default:3. 1 = Real, 2 = Disable HW
            acceleration, 3 = Custom.
        provider:
          type: string
          description: WebGL vendor string (e.g., "Google Inc.")
        render:
          type: string
          description: WebGL renderer string (e.g., "ANGLE (...)")
    AudioContextConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: AudioContext policy. Default:1. 1 = Noise, 2 = Realistic.
    MediaDeviceConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Media device policy. Default:1. 1 = Noise, 2 = Real.
    ClientRectsConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: ClientRects policy. Default:1. 1 = Noise, 2 = Real.
    SpeechVoiseConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: SpeechVoices policy. Default:1. 1 = Privacy, 2 = Real
    BluetoothConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Bluetooth policy. Default:1. 1 = Privacy, 2 = Authenticity.
    BatteryConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Battery policy. Default:1. 1 = Privacy, 2 = Authenticity.
    PortScanProtectionConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: Port scan protection. Default:1. 1 = On, 2 = Off.
        value:
          type: string
          description: Allowed local network ports to connect (comma-separated).
    WebGPUConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: >-
            WebGPU policy. Default:1. 1 = WebGL-based matching, 2 = true, 3 =
            disabled.
    AfterStartupConfig:
      type: object
      properties:
        afterStartup:
          type: integer
          format: int32
          description: |
            Action after startup. Default:1.
            1 = Continue last page,
            2 = Open specified URLs,
            3 = Open URLs + platform,
            4 = Continue last page + platform.
        autoOpenUrls:
          type: array
          items:
            type: string
            format: uri
          description: List of valid URLs to open automatically (required for options 2–3).
    CiphersConfig:
      type: object
      properties:
        switcher:
          type: integer
          description: TLS cipher policy. Default:1. 1 = Default, 2 = Custom.
        value:
          type: string
          description: >
            Required when switcher=2.

            Comma-separated list of TLS protocols to disable (e.g.,
            "TLSv1,TLSv1.1").
    platformList:
      type: object
      properties:
        id:
          type: string
          description: Platform ID
        categoryId:
          type: string
          description: Category ID
        groupName:
          type: string
          description: Group name
        groups:
          type: string
          description: Group，0：Amazon
        isCustomer:
          type: boolean
          description: Whether to customize the platform
        logo:
          type: string
          description: Platform logo
        name:
          type: string
          description: Platform name
        orderNo:
          type: string
          description: Sort Number
        sites:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Site ID
              host:
                type: string
                description: Site Domain Name
              name:
                type: string
                description: Size name
              nameBak:
                type: string
                description: Size name backup
              logo:
                type: string
                description: Logo
              url:
                type: string
                description: Size URL
              isDefault:
                type: boolean
              country:
                type: string
                description: Country
            required:
              - id
              - host
              - name
              - logo
              - nameBak
              - url
              - isDefault
              - country
          description: Sites information
      required:
        - categoryId
        - groupName
        - groups
        - id
        - isCustomer
        - logo
        - name
        - orderNo
        - sites
    browser phone list:
      type: object
      properties:
        code:
          description: Return result code 0:Normal Other codes are exceptions.
          type: integer
        msg:
          description: Error message
          type: string
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              resolution:
                type: string
              os:
                type: integer
              platform:
                type: string
        requestId:
          description: Operation request ID
          type: string
      required:
        - code
        - msg
        - data
        - requestId
    CloudPhoneProfile:
      type: object
      properties:
        abnormalStatus:
          type: integer
          description: >-
            Abnormal status 0-No abnormality 1-Unactivated 2-Out-of-contract
            3-Oversold 4-Deactivated
        adbInfo:
          $ref: '#/components/schemas/AdbInfo'
        billingType:
          type: integer
          description: Billing:0-Free 1-Flexible subscription 2-Monthly
        createDate:
          type: string
          format: date-time
        createMember:
          type: integer
        createMemberName:
          type: string
        enableAdb:
          type: boolean
        envName:
          type: string
          description: Cloud Phone Name
        envRemark:
          type: string
          description: Profile Remarks
        envStatus:
          type: integer
          description: >-
            Profile Status:0-New 1-Creation Failed 2-Stop 3-Starting up 4-Start
            5-Reset In Progress
        expireTime:
          type: integer
          description: expiration time
        groupId:
          type: integer
        groupInfo:
          type: array
          items:
            $ref: '#/components/schemas/TagInfo'
        id:
          type: integer
          format: int64
        lastConnectDate:
          type: string
          format: date-time
        lastConnectMemberId:
          type: integer
        lastConnectMemberName:
          type: string
        lastStartDate:
          type: string
          format: date-time
        lastStartMemberId:
          type: integer
        lastStartMemberName:
          type: string
        proxy:
          $ref: '#/components/schemas/ProxyInfo'
        proxyStatus:
          type: integer
          description: >-
            Proxy Status:0-Not Detected 1-Detecting 2-Detecting Failed
            3-Detecting Successful
        supportAdb:
          type: boolean
        tagIds:
          type: array
          items:
            type: string
        tagInfo:
          type: array
          items:
            $ref: '#/components/schemas/TagInfo'
        updateDate:
          type: string
          format: date-time
        updateMember:
          type: integer
    AdbInfo:
      type: object
      properties:
        adbIp:
          type: string
          description: adb ip
        adbPassword:
          type: string
          description: adb connection password
        adbPort:
          type: string
          description: adb port
        remark:
          type: string
          description: Failure Remarks Information
        success:
          type: integer
          description: Successful acquisition 1=Yes 0=No
      required:
        - adbIp
        - adbPassword
        - adbPort
        - remark
        - success
    ProxyInfo:
      type: object
      properties:
        country:
          type: string
        countryCode:
          type: string
        createDate:
          type: string
          format: date-time
        delFlag:
          type: integer
          description: 1 - deleted 2 - not deleted
        expiryTime:
          type: integer
        exportIp:
          type: string
        groupId:
          type: integer
        id:
          type: integer
          format: int64
        providerCode:
          type: string
        proxyAreaCode:
          type: string
        proxyCatagoryType:
          type: integer
          description: >-
            Proxy type:0:site group 1:cloud platform 2:own IP 3:vps 4:virtual
            machine
        proxyCheckStatus:
          type: integer
          description: >-
            Detection status:0:pending detection 1:successful detection
            2:detection failure 3:unknown error
        proxyInfo:
          type: string
        proxyIp:
          type: string
        proxyName:
          type: string
        proxyPort:
          type: integer
        proxyRegionCode:
          type: string
        proxyStatus:
          type: integer
          description: 0-Normal 1-Pending allocation 2-Upgrading 3-Expired
        proxySub:
          $ref: '#/components/schemas/ProxySubscription'
        proxyType:
          type: integer
          description: >-
            Proxy type：0-http 1-https 2-socks5 4-Oxylabs 5-Proxys.io 6-GeoSurf
            9-Oxylabsauto 10-Trogan 11-Shadowsocks 12-vmess
        proxyTypeCode:
          type: string
        regionKey:
          type: string
        releaseTime:
          type: string
          format: date-time
          description: Release time:deletion time if deleted, expiration time if expired
        uniqueId:
          type: integer
      required:
        - country
        - countryCode
        - createDate
        - delFlag
        - expiryTime
        - exportIp
        - groupId
        - id
        - providerCode
        - proxyAreaCode
        - proxyCatagoryType
        - proxyCheckStatus
        - proxyInfo
        - proxyIp
        - proxyName
        - proxyPort
        - proxyRegionCode
        - proxyStatus
        - proxySub
        - proxyType
        - proxyTypeCode
        - regionKey
        - releaseTime
        - uniqueId
    ProxySubscription:
      type: object
      properties:
        activeRecordId:
          type: integer
        businessId:
          type: string
        createMember:
          type: integer
        endTime:
          type: integer
        id:
          type: integer
        nextBillingTime:
          type: integer
        startTime:
          type: integer
        subPayMethod:
          type: string
        subStatus:
          type: integer
          description: Subscription Status:0-Pending 1-Subscribed 2-Cancelled
        subType:
          type: integer
          description: Subscription Type:1-Agent 2-Package
        teamId:
          type: integer
      required:
        - activeRecordId
        - businessId
        - createMember
        - endTime
        - id
        - nextBillingTime
        - startTime
        - subPayMethod
        - subStatus
        - subType
        - teamId
    TagInfo:
      type: object
      properties:
        id:
          type: integer
        tagIcon:
          type: string
        tagName:
          type: string
        tagSource:
          type: string
          description: 'Tag Source: ENV profile, PROXY proxy'
        tagType:
          type: string
          description: 'Tag type: TAG tag, GROUP group'
    CloudPhoneDetail:
      type: object
      properties:
        id:
          type: string
        envName:
          type: string
        groupId:
          type: string
        skuId:
          type: string
        tagIds:
          type: array
          items:
            type: string
        billingType:
          type: integer
        proxyStatus:
          type: integer
        settings:
          type: object
          properties:
            automaticGeo:
              type: boolean
            automaticLocation:
              type: boolean
            automaticLanguage:
              type: boolean
            longitude:
              type: number
              nullable: true
            latitude:
              type: number
              nullable: true
          required:
            - automaticGeo
            - automaticLocation
            - automaticLanguage
            - longitude
            - latitude
        device:
          type: object
          properties:
            server:
              type: string
              nullable: true
            countryName:
              type: string
            rom:
              type: integer
            wifiBssid:
              type: string
              nullable: true
            bluetoothMac:
              type: string
          required:
            - server
            - countryName
            - rom
            - wifiBssid
            - bluetoothMac
        proxy:
          type: object
          properties:
            id:
              type: string
            proxyName:
              type: string
            proxyIp:
              type: string
          required:
            - id
            - proxyName
            - proxyIp
        lastStartMemberId:
          type: string
        lastStartMemberName:
          type: string
          nullable: true
        lastStartDate:
          type: string
          format: date-time
        lastConnectMemberId:
          type: string
        lastConnectMemberName:
          type: string
          nullable: true
        lastConnectDate:
          type: string
          format: date-time
        envStatus:
          type: integer
        abnormalStatus:
          type: integer
        expireTime:
          type: string
        envRemark:
          type: string
        createMember:
          type: string
        updateMember:
          type: string
        updateDate:
          type: string
          format: date-time
        createDate:
          type: string
          format: date-time
        createMemberName:
          type: string
          nullable: true
      required:
        - id
        - envName
        - groupId
        - skuId
        - tagIds
        - billingType
        - proxyStatus
        - settings
        - device
        - proxy
        - lastStartMemberId
        - lastStartMemberName
        - lastStartDate
        - lastConnectMemberId
        - lastConnectMemberName
        - lastConnectDate
        - envStatus
        - abnormalStatus
        - expireTime
        - envRemark
        - createMember
        - updateMember
        - updateDate
        - createDate
        - createMemberName
    Execution DTO:
      type: object
      properties:
        id:
          type: integer
          description: Execution record id
        taskName:
          type: string
          description: Schedule Task name
        taskState:
          type: integer
          description: >-
            Schedule status; 0:awaiting execution; 1:Executing; 2:Execution
            completed 3:Cancel
        cloudPhoneId:
          type: integer
          description: Cloud phone ID
        cloudPhoneName:
          type: string
          description: Cloud phone name
        templateName:
          type: string
          description: Template title
        handleFailCode:
          type: string
          description: Task failure code
        handleFailReason:
          type: string
          description: Task failure reason
        handleResult:
          type: integer
          description: Task result. 0:failed; 1:succeeded
        handleResultAttachment:
          type: string
          description: Task execution result attachment
        handleTime:
          type: string
          description: Execution time
        endTime:
          type: string
          description: Task end time
        powerOnTime:
          type: string
          description: Cloud phone power-on time
        triggerNextTime:
          type: string
          description: Next scheduled trigger time
        triggerTime:
          type: string
          description: Scheduled trigger time
        createDate:
          type: string
          description: ' Creation time'
        createMember:
          type: string
          description: Creator
        updateDate:
          type: string
          description: Last update time
        updateMember:
          type: string
          description: Last updater
  responses:
    '402':
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
              message:
                type: string
            required:
              - code
              - message
    '404':
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
              message:
                type: string
            required:
              - code
              - message
  securitySchemes: {}
servers:
  - url: http://127.0.0.1:40000
    description: Morelogin  Local endponint
security: []
